Add business metrics implementation guidelines #6527
Conversation
S-Saranya1
added
the
changelog-not-required
|
|
||
| ### Avoid Request Mutation for Business Metrics | ||
|
|
||
| **SHOULD NOT** use request mutation (`.toBuilder().build()`) for adding business metrics as it creates unnecessary object copies and performance overhead. |
There was a problem hiding this comment.
What about high level features which adds the User agent where the features are resolved before the context is built based on the Client settings? Should we also directly add it to the Execution Attribute ? (As in Transfer manager, Batch manager, CrossRegion etc)
There was a problem hiding this comment.
Hmm yeah, good point to cover! Yes, if there are cases where high-level features are resolved before ExecutionContext is built and we can't access ExecutionAttributes directly.
We have two options: if we can somehow determine the feature from client configuration or execution parameters (like retry mode and protocol detection already do), then we can add it in AwsExecutionContextBuilder in core which avoids request mutation. But, if the feature requires analyzing specific request details that aren't available in client config, then request mutation is acceptable as a fallback ig. Will update the doc about it.
|
Thanks for creating the guidelines this is very helpful. |
Changes to existing business metrics should be treated as backward compatible and only require a minor version bump I feel, what do you think? Since business metrics are purely observational, and don't affect SDK functionality or customer code behavior, customer applications remain unaffected, so changes like modifying an existing business metric are safe changes I feel. A minor version bump is sufficient and helps teams track when metric changes were introduced. |
yeap minor version bump looks good |
|
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
|
This pull request has been closed and the conversation has been locked. Comments on closed PRs are hard for our team to see. If you need more assistance, please open a new issue that references this one. |
3 participants
This PR adds guidelines for implementing business metrics in the AWS SDK for Java v2, based on team decisions.